Foxit PDF SDK
FoxitPDFSDKPython3.ActionCallback类 参考

继承自 FoxitPDFSDKPython3._object .

Public 成员函数

def AddMenuItem (menu_item_config, is_prepend)
 向菜单添加菜单项的回调函数。
更多...
 
def AddSearchIndex (di_path, is_selected)
 添加搜索索引的回调函数。
更多...
 
def AddSubMenu (menu_item_config)
 向应用程序添加带有子菜单的菜单项的回调函数。
更多...
 
def AddToolButton (button_item)
 添加工具按钮的回调函数。
更多...
 
def Alert (msg, title, type, icon)
 弹出对话框显示警告或提示的回调函数。
更多...
 
def Beep (type)
 使系统播放声音的回调函数。
更多...
 
def BrowseFile ()
 显示文件选择对话框的回调函数,选择的文件路径应该被返回。
更多...
 
def BrowseFile (is_open_dialog, file_format, file_filter)
 显示文件选择对话框的回调函数。
更多...
 
def CloseDoc (document, is_prompt_to_save)
 关闭文档的回调函数。
更多...
 
def CreateBlankDoc ()
 创建空白PDF文档对象的回调函数。
更多...
 
def EnablePageLoop (is_loop)
 设置标志的回调函数,该标志指定在全屏模式下,文档是否会循环回到文档开头以响应页面前进(无论是由鼠标点击、键盘还是计时器生成)。
更多...
 
def ExecuteNamedAction (document, named_action)
 执行命名操作的回调函数。
更多...
 
def GetAppInfo (type)
 获取应用程序信息的回调函数。
更多...
 
def GetAttachmentsFilePath (pdf_doc, name)
 获取附件文件路径的回调函数。
更多...
 
def GetCurrentDoc ()
 接收当前PDF文档对象的回调函数。
更多...
 
def GetCurrentPage (document)
 用于接收当前页面索引的回调函数。
更多...
 
def GetDocChangeMark (document)
 接收更改标记的回调函数,该标记指示文档内容是否已更改。
更多...
 
def GetExtractedEmbeddedFilePath (pdf_doc, name)
 获取提取的嵌入文件路径的回调函数。
更多...
 
def GetFilePath (document)
 获取当前PDF文档文件路径的回调函数。
更多...
 
def GetFullScreen ()
 获取是否设置了全屏模式的回调函数。
更多...
 
def GetIdentityProperties ()
 获取当前用户身份属性的回调函数。
更多...
 
def GetLanguage ()
 获取正在运行的查看器应用程序语言的回调函数。
更多...
 
def GetLayoutMode ()
 获取当前文档页面布局的回调函数。
更多...
 
def GetMenuItemNameList ()
 获取菜单项名称列表的回调函数。
更多...
 
def GetMousePosition ()
 获取当前鼠标位置的回调函数。
更多...
 
def GetOpenedDoc (index)
 通过索引接收已打开PDF文档对象的回调函数。
更多...
 
def GetOpenedDocCount ()
 接收已打开文档数量的回调函数。
更多...
 
def GetPageRotation (document, page_index)
 用于接收PDF查看器中页面当前显示旋转值的回调函数。
更多...
 
def GetPageScale ()
 获取当前页面缩放值的回调函数。
更多...
 
def GetPageWindowRect (pdf_doc, page_index)
 获取页面视图窗口矩形的回调函数。页面视图窗口是 内部文档窗口中显示PDF内容的区域。
更多...
 
def GetPageZoomMode ()
 获取当前页面缩放模式的回调函数。
更多...
 
def GetPrinterNameList ()
 获取打印机名称列表的回调函数。
更多...
 
def GetSignatureAPStyleNameList ()
 获取签名外观样式名称列表的回调函数。
更多...
 
def GetTemporaryDirectory ()
 获取临时目录的回调函数。
更多...
 
def GetTemporaryFileName (document, file_suffix_name)
 获取临时文件路径的回调函数。临时文件名将文档名与文件后缀名组合。
更多...
 
def GetUntitledBookmarkName ()
 获取无标题书签新名称的回调函数。
更多...
 
def GetVisiblePage (document, index)
 获取可见页的回调。
更多...
 
def GetVisiblePageCount (document)
 获取可见页页数的回调。
更多...
 
def InitModifyItem (document, item_type, page_index, dict_name)
 初始化修改项的回调。
更多...
 
def InvalidateRect (document, page_index, pdf_rect)
 使指定矩形内的客户区域无效的回调函数。
更多...
 
def IsCurrentDocOpenedInBrowser ()
 获取标志的回调函数,该标志指定当前文档是否在浏览器中打开。
更多...
 
def IsLocalFile (document)
 检查文件是否为本地文件的回调函数。
更多...
 
def IsPageLoop ()
 获取标志的回调函数,该标志指定文档是否会循环回到文档开头以响应页面前进。
更多...
 
def LaunchURL (url)
 启动到指定URL的回调函数。
更多...
 
def MailData (data, data_type, is_ui, to, subject, cc, bcc, message)
 发送数据或消息的回调函数,可以带有或不带有用户交互。
更多...
 
def MailDoc (document, to_address, cc_address, bcc_address, subject, message, is_ui)
 将文档作为附件发送邮件的回调函数。
更多...
 
def NotifyAfterDataChange (document, modify_item_info)
 用于通知JS执行后内容已经被修改的回调函数。
更多...
 
def NotifyBeginDoJob (document, event_type)
 用于通知JS开始执行的回调函数。
更多...
 
def NotifyEndDoJob (document, event_type)
 用于通知JS已经执行结束。
更多...
 
def OnFieldValueChanged (field_name, type, value_before_changed, value_after_changed)
 通知字段值变化的回调函数。
更多...
 
def OpenDoc (file_path, password)
 打开PDF文件的回调函数。
更多...
 
def OpenMediaPlayer (player_args)
 打开媒体播放器的回调函数。
更多...
 
def PopupMenu (menus, is_selected_item)
 弹出菜单窗口的回调函数。
更多...
 
def PopupMenuEx (menus, is_selected_item)
 弹出菜单窗口的回调函数。
更多...
 
def PostMessageToHtml (message)
 向PDF文档的宿主容器的消息处理程序异步发送消息的回调函数。
更多...
 
def Print (document, is_ui, page_range, is_silent, is_shrunk_to_fit, is_printed_as_image, is_reversed, is_to_print_annots)
 打印指定索引范围内页面的回调函数。
更多...
 
def Print (document, print_params)
 使用打印参数打印文档的回调函数。
更多...
 
def Query (keywords, search_scope, search_option, di_path)
 查询文本关键字的回调函数。
更多...
 
def Release ()
 用于释放当前回调对象本身的回调函数。
更多...
 
def RemoveSearchIndex (search_index_config)
 (保留,尚不支持)移除搜索索引的回调函数。
更多...
 
def RemoveToolButtom (button_name)
 移除通过函数 FoxitPDFSDKPython3.ActionCallback.AddToolButton 添加的工具按钮的回调函数。
更多...
 
def ResetModifyItem (document)
 重置修改项的回调。
更多...
 
def Response (question, title, default_value, label, is_password)
 显示包含问题和输入字段供用户回复问题的对话框的回调函数。
更多...
 
def Scroll (point)
 将当前页面上指定点滚动到当前视图中央的回调函数。
更多...
 
def SelectPageNthWord (page_index, start_offset, end_offset, is_show_selection)
 更改当前页码并选择页面上指定单词的回调函数。
更多...
 
def SetCurrentPage (document, destination)
 用于根据目标设置当前页面的回调函数。
更多...
 
def SetDefaultPageTransitionMode (trans_type, trans_di)
 设置全屏模式下默认页面过渡模式的回调函数。
更多...
 
def SetDocChangeMark (document, change_mark)
 设置更改标记的回调函数,该标记指示文档内容是否已更改。
更多...
 
def SetFullScreen (is_full_screen)
 设置全屏模式的回调函数。
更多...
 
def SetIdentityProperties (identity_properties)
 设置当前用户身份属性的回调函数。
更多...
 
def SetLayoutMode (layout_mode, is_cover_mode)
 设置当前文档页面布局的回调函数。
更多...
 
def SetPageRotation (document, page_index, rotation)
 用于在PDF查看器中设置页面旋转值的回调函数。
更多...
 
def SetPageScale (zoom_mode, dest)
 设置当前页面缩放值的回调函数。
更多...
 
def ShowDialog (dlg_config)
 显示对话框的回调函数。
更多...
 
def SoapRequest (request_params)
 启动远程过程调用 (RPC) 或向 SOAP HTTP 端点发送 XML 消息。
更多...
 
def SubmitForm (document, form_data, length, url, file_format_type)
 向指定URL提交表单数据的回调函数。
更多...
 
def UpdateLogicalLabel ()
 更新逻辑标签的回调函数。
更多...
 
def VerifySignature (document, pdf_signature)
 验证指定签名的回调函数。
更多...
 

静态 Public 属性

 e_AppInfoTypeAppVersion = _fsdk.ActionCallback_e_AppInfoTypeAppVersion
 应用程序的应用版本信息。

 
 e_AppInfoTypeFormsVersion = _fsdk.ActionCallback_e_AppInfoTypeFormsVersion
 应用程序的表单版本信息。

 
 e_AppInfoTypeViewerType = _fsdk.ActionCallback_e_AppInfoTypeViewerType
 应用程序的查看器类型信息。

 
 e_AppInfoTypeViewerVariation = _fsdk.ActionCallback_e_AppInfoTypeViewerVariation
 应用程序的查看器变体信息。

 
 e_AppInfoTypeViewerVersion = _fsdk.ActionCallback_e_AppInfoTypeViewerVersion
 应用程序的查看器版本信息。

 
 e_JSFieldValueChangedByCalculation = _fsdk.ActionCallback_e_JSFieldValueChangedByCalculation
 JavaScript字段值变更类型:计算。

 
 e_JSFieldValueChangedByFillColor = _fsdk.ActionCallback_e_JSFieldValueChangedByFillColor
 JavaScript字段值变更类型:字段填充颜色。

 
 e_JSFieldValueChangedByFormat = _fsdk.ActionCallback_e_JSFieldValueChangedByFormat
 JavaScript字段值变更类型:格式化。

 
 e_JSFieldValueChangedBySetReadOnly = _fsdk.ActionCallback_e_JSFieldValueChangedBySetReadOnly
 JavaScript字段值变更类型:字段设置只读属性。

 
 e_JSFieldValueChangedBySetValue = _fsdk.ActionCallback_e_JSFieldValueChangedBySetValue
 JavaScript字段值变更类型:字段设置值。

 
 e_JSMailResultFailed = _fsdk.ActionCallback_e_JSMailResultFailed
 邮件结果:邮件发送失败。

 
 e_JSMailResultSuccess = _fsdk.ActionCallback_e_JSMailResultSuccess
 邮件结果:邮件发送成功。

 
 e_JSMailResultUserAbort = _fsdk.ActionCallback_e_JSMailResultUserAbort
 邮件结果:用户中止。

 
 e_JSMediaPlayerStateClose = _fsdk.ActionCallback_e_JSMediaPlayerStateClose
 媒体播放器状态:关闭。

 
 e_JSMediaPlayerStateOpen = _fsdk.ActionCallback_e_JSMediaPlayerStateOpen
 媒体播放器状态:打开。

 
 e_JSMediaPlayerStatePlaying = _fsdk.ActionCallback_e_JSMediaPlayerStatePlaying
 媒体播放器状态:播放中。

 
 e_JSMediaPlayerStateStop = _fsdk.ActionCallback_e_JSMediaPlayerStateStop
 媒体播放器状态:停止。

 
 e_JSMediaPlayerStateSuspend = _fsdk.ActionCallback_e_JSMediaPlayerStateSuspend
 媒体播放器状态:暂停。

 
 e_LanguageCHS = _fsdk.ActionCallback_e_LanguageCHS
 简体中文。

 
 e_LanguageCHT = _fsdk.ActionCallback_e_LanguageCHT
 繁体中文。

 
 e_LanguageDAN = _fsdk.ActionCallback_e_LanguageDAN
 丹麦语。

 
 e_LanguageDEU = _fsdk.ActionCallback_e_LanguageDEU
 德语。

 
 e_LanguageENU = _fsdk.ActionCallback_e_LanguageENU
 英语。

 
 e_LanguageESP = _fsdk.ActionCallback_e_LanguageESP
 西班牙语。

 
 e_LanguageFRA = _fsdk.ActionCallback_e_LanguageFRA
 法语。

 
 e_LanguageITA = _fsdk.ActionCallback_e_LanguageITA
 意大利语。

 
 e_LanguageJPN = _fsdk.ActionCallback_e_LanguageJPN
 日语。

 
 e_LanguageKOR = _fsdk.ActionCallback_e_LanguageKOR
 韩语。

 
 e_LanguageNLD = _fsdk.ActionCallback_e_LanguageNLD
 荷兰语。

 
 e_LanguageNOR = _fsdk.ActionCallback_e_LanguageNOR
 挪威语。

 
 e_LanguagePTB = _fsdk.ActionCallback_e_LanguagePTB
 巴西葡萄牙语。

 
 e_LanguageSUO = _fsdk.ActionCallback_e_LanguageSUO
 芬兰语。

 
 e_LanguageSVE = _fsdk.ActionCallback_e_LanguageSVE
 瑞典语。

 
 e_LanguageUnknown = _fsdk.ActionCallback_e_LanguageUnknown
 未知语言。

 
 e_LayoutModeContinuous = _fsdk.ActionCallback_e_LayoutModeContinuous
 布局模式:连续页面。

 
 e_LayoutModeContinuousFacing = _fsdk.ActionCallback_e_LayoutModeContinuousFacing
 布局模式:连续双页。

 
 e_LayoutModeFacing = _fsdk.ActionCallback_e_LayoutModeFacing
 布局模式:双页。

 
 e_LayoutModeSinglePage = _fsdk.ActionCallback_e_LayoutModeSinglePage
 布局模式:单页。

 
 e_MailTypeDoc = _fsdk.ActionCallback_e_MailTypeDoc
 邮寄数据类型:文档。

 
 e_MailTypeForm = _fsdk.ActionCallback_e_MailTypeForm
 邮寄数据类型:表单。

 
 e_MailTypeMsg = _fsdk.ActionCallback_e_MailTypeMsg
 邮寄数据类型:字符串消息。

 
 e_SearchScopeActiveDoc = _fsdk.ActionCallback_e_SearchScopeActiveDoc
 搜索范围:活动文档。

 
 e_SearchScopeActiveIndexes = _fsdk.ActionCallback_e_SearchScopeActiveIndexes
 搜索范围:活动索引。

 
 e_SearchScopeFolder = _fsdk.ActionCallback_e_SearchScopeFolder
 搜索范围:文件夹。

 
 e_SearchScopeIndex = _fsdk.ActionCallback_e_SearchScopeIndex
 搜索范围:索引。

 

详细描述

此类表示执行PDF动作的回调对象。 此类中的所有纯虚函数都用作回调函数,应由用户实现, 以执行PDF动作,如JavaScript动作。

成员函数说明

◆ AddMenuItem()

def FoxitPDFSDKPython3.ActionCallback.AddMenuItem (   menu_item_config,
  is_prepend 
)

向菜单添加菜单项的回调函数。

此回调函数将由JavaScript方法"app.addMenuItem"触发。

参数
[in]menu_item_config菜单项的配置。
[in]is_prepend确定新菜单项相对于由 MenuItemConfig::posMenuItemConfig::pos_str 指定位置的位置。 默认值为 false。如果此参数为 true,插入规则如下:
  • 如果使用 MenuItemConfig::pos_str,新项目将放置在命名项目之前。
  • 如果使用 MenuItemConfig::pos,新项目将放置在编号项目之前。
  • 如果找不到命名项目或位置不在零和列表中项目数之间(包括零和项目数), 新项目将作为菜单中的第一个项目插入(而不是在菜单末尾)。
当命名项目是组中的第一个项目时,此参数非常有用。
返回
true 表示成功,false 表示失败。

◆ AddSearchIndex()

def FoxitPDFSDKPython3.ActionCallback.AddSearchIndex (   di_path,
  is_selected 
)

添加搜索索引的回调函数。

此回调函数将由JavaScript方法"search.addIndex"触发。此回调函数是可选的, 因此可以实现为不做任何事情。

参数
[in]di_path用户硬盘上索引文件的设备无关路径。
[in]is_selected指定是否应选择索引进行搜索。默认值:true
返回
一个 SearchIndexConfig

◆ AddSubMenu()

def FoxitPDFSDKPython3.ActionCallback.AddSubMenu (   menu_item_config)

向应用程序添加带有子菜单的菜单项的回调函数。

此回调函数将由JavaScript方法"app.addSubMenu"触发。

参数
[in]menu_item_config菜单项的配置。
返回
true 表示成功,false 表示失败。

◆ AddToolButton()

def FoxitPDFSDKPython3.ActionCallback.AddToolButton (   button_item)

添加工具按钮的回调函数。

此回调函数将由JavaScript方法"app.addToolButton"触发。

参数
[in]button_item工具按钮的 ButtonItem 对象。
返回
true 表示成功,false 表示失败。

◆ Alert()

def FoxitPDFSDKPython3.ActionCallback.Alert (   msg,
  title,
  type,
  icon 
)

弹出对话框显示警告或提示的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]msg要在对话框中显示的消息字符串。
[in]title对话框的标题。
[in]type按钮组类型。它应该是以下值之一:
  • 0: OK;(默认值。)
  • 1: OK, Cancel;
  • 2: Yes, NO;
  • 3: Yes, NO, Cancel.

[in]icon图标类型。它应该是以下值之一:
  • 0: Error;(默认值。)
  • 1: Warning;
  • 2: Question;
  • 3: Status.

返回
返回值应该是以下值之一:
  • 1: OK;
  • 2: Cancel;
  • 3: NO;
  • 4: Yes;

◆ Beep()

def FoxitPDFSDKPython3.ActionCallback.Beep (   type)

使系统播放声音的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]type声音类型。值应为以下值之一:
  • 0: 错误
  • 1: 警告
  • 2: 问题
  • 3: 状态
  • 4: 默认(默认值)

返回
true 表示成功,false 表示失败。

◆ BrowseFile() [1/2]

def FoxitPDFSDKPython3.ActionCallback.BrowseFile ( )

显示文件选择对话框的回调函数,选择的文件路径应该被返回。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

返回
文件路径。可以是空字符串。

◆ BrowseFile() [2/2]

def FoxitPDFSDKPython3.ActionCallback.BrowseFile (   is_open_dialog,
  file_format,
  file_filter 
)

显示文件选择对话框的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]is_open_dialog布尔值,指定对话框是用于打开文件还是保存文件。 true 表示对话框应用于打开文件,false 表示 对话框应用于保存文件。
[in]file_format文件格式字符串。
[in]file_filter文件过滤器字符串。
返回
文件路径。可以是空字符串。

◆ CloseDoc()

def FoxitPDFSDKPython3.ActionCallback.CloseDoc (   document,
  is_prompt_to_save 
)

关闭文档的回调函数。

此回调函数将由JavaScript方法"Doc.closeDoc"触发。 此回调函数是可选的,因此可以实现为不做任何事情。

参数
[in]documentPDF文档对象。它应该是有效的。
[in]is_prompt_to_savetrue 表示显示保存提示,false 表示不显示。
返回
无。

◆ CreateBlankDoc()

def FoxitPDFSDKPython3.ActionCallback.CreateBlankDoc ( )

创建空白PDF文档对象的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

返回
新创建的空白PDF文档对象。

◆ EnablePageLoop()

def FoxitPDFSDKPython3.ActionCallback.EnablePageLoop (   is_loop)

设置标志的回调函数,该标志指定在全屏模式下,文档是否会循环回到文档开头以响应页面前进(无论是由鼠标点击、键盘还是计时器生成)。

此回调函数将由JavaScript属性"app.fs.loop"触发。 此回调函数是可选的,因此可以实现为不做任何事情。

参数
[in]is_looptrue 表示循环回到文档开头,false 表示不循环。
返回
无。

◆ ExecuteNamedAction()

def FoxitPDFSDKPython3.ActionCallback.ExecuteNamedAction (   document,
  named_action 
)

执行命名操作的回调函数。

请参考<PDF Reference 1.7>第8.5.3节中"命名操作"的描述以获取更多详细信息。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]documentPDF文档对象。它应该是有效的。
[in]named_action指定命名操作的字符串。
返回
true 表示成功,false 表示失败。

◆ GetAppInfo()

def FoxitPDFSDKPython3.ActionCallback.GetAppInfo (   type)

获取应用程序信息的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
对于数字信息,如 FoxitPDFSDKPython3.ActionCallback.e_AppInfoTypeViewerVersion FoxitPDFSDKPython3.ActionCallback.e_AppInfoTypeAppVersion FoxitPDFSDKPython3.ActionCallback.e_AppInfoTypeFormsVersion ,请使用字符串来表示。

参数
[in]type信息类型。请参考从 FoxitPDFSDKPython3.ActionCallback.e_AppInfoTypeFormsVersion 开始的值,它应该是这些值中的一个。
返回
应用程序信息。

◆ GetAttachmentsFilePath()

def FoxitPDFSDKPython3.ActionCallback.GetAttachmentsFilePath (   pdf_doc,
  name 
)

获取附件文件路径的回调函数。

此回调函数将由JavaScript方法"Doc.importDataObject"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]pdf_docPDF文档对象。它将嵌入一个数据对象。
[in]name与数据对象关联的名称。这是方法"Doc.importDataObject"的参数"cName"。
返回
将作为数据对象嵌入的文件路径。

◆ GetCurrentDoc()

def FoxitPDFSDKPython3.ActionCallback.GetCurrentDoc ( )

接收当前PDF文档对象的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

返回
当前PDF文档对象。

◆ GetCurrentPage()

def FoxitPDFSDKPython3.ActionCallback.GetCurrentPage (   document)

用于接收当前页面索引的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]documentPDF文档对象。它应该是有效的。
返回
当前页面索引。该值应该从0开始,小于指定文档的页数。

◆ GetDocChangeMark()

def FoxitPDFSDKPython3.ActionCallback.GetDocChangeMark (   document)

接收更改标记的回调函数,该标记指示文档内容是否已更改。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]documentPDF文档对象。它应该是有效的。
返回
true 表示PDF文档已更改,false 表示未更改。

◆ GetExtractedEmbeddedFilePath()

def FoxitPDFSDKPython3.ActionCallback.GetExtractedEmbeddedFilePath (   pdf_doc,
  name 
)

获取提取的嵌入文件路径的回调函数。

此回调函数将由JavaScript方法"Doc.exportDataObject"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]pdf_docPDF文档对象。它将作为数据对象嵌入到文件中。
[in]name要提取的数据对象的名称。这是方法"Doc.exportDataObject"的参数"cName"。
返回
将嵌入数据对象的文件路径。

◆ GetFilePath()

def FoxitPDFSDKPython3.ActionCallback.GetFilePath (   document)

获取当前PDF文档文件路径的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]documentPDF文档对象。它应该是有效的。
返回
文件路径。

◆ GetFullScreen()

def FoxitPDFSDKPython3.ActionCallback.GetFullScreen ( )

获取是否设置了全屏模式的回调函数。

此回调函数将由JavaScript属性"app.fullScreen"或"app.fs.isFullScreen"触发。

返回
true 表示设置了全屏模式,false 表示未设置。

◆ GetIdentityProperties()

def FoxitPDFSDKPython3.ActionCallback.GetIdentityProperties ( )

获取当前用户身份属性的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

返回
指定当前用户身份属性的身份属性对象。

◆ GetLanguage()

def FoxitPDFSDKPython3.ActionCallback.GetLanguage ( )

获取正在运行的查看器应用程序语言的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

返回
语言类型。请参考从 FoxitPDFSDKPython3.ActionCallback.e_LanguageUnknown 开始的值, 它应该是这些值中的一个。

◆ GetLayoutMode()

def FoxitPDFSDKPython3.ActionCallback.GetLayoutMode ( )

获取当前文档页面布局的回调函数。

此回调函数将由JavaScript属性"Doc.layout"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

返回
布局模式。请参考从 FoxitPDFSDKPython3.ActionCallback.e_LayoutModeSinglePage 开始的值, 它应该是这些值中的一个。

◆ GetMenuItemNameList()

def FoxitPDFSDKPython3.ActionCallback.GetMenuItemNameList ( )

获取菜单项名称列表的回调函数。

此回调函数将由JavaScript方法"app.listMenuItems"触发。

返回
菜单列表对象的数组。

◆ GetMousePosition()

def FoxitPDFSDKPython3.ActionCallback.GetMousePosition ( )

获取当前鼠标位置的回调函数。

此回调函数将由JavaScript属性"doc.mouseX"或"doc.mouseY"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

返回
设备坐标系统中的位置。

◆ GetOpenedDoc()

def FoxitPDFSDKPython3.ActionCallback.GetOpenedDoc (   index)

通过索引接收已打开PDF文档对象的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]index已打开PDF文档的索引。有效范围:从0到 count-1。 count 由回调函数 FoxitPDFSDKPython3.ActionCallback.GetOpenedDocCount 返回;
返回
已打开的PDF文档对象。

◆ GetOpenedDocCount()

def FoxitPDFSDKPython3.ActionCallback.GetOpenedDocCount ( )

接收已打开文档数量的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

返回
已打开文档的数量。

◆ GetPageRotation()

def FoxitPDFSDKPython3.ActionCallback.GetPageRotation (   document,
  page_index 
)

用于接收PDF查看器中页面当前显示旋转值的回调函数。

此回调函数是可选的,可以实现为不执行任何操作, 仅返回一个无用的值。

参数
[in]documentPDF文档对象。该对象应当是有效的。
[in]page_index页面索引,用于指定要获取旋转值的页面。 索引从0开始,应小于指定文档的页面总数。
返回
指定页面的旋转值。请参考从 FoxitPDFSDKPython3.e_Rotation0 开始的值, 应当是这些值中的一个。

◆ GetPageScale()

def FoxitPDFSDKPython3.ActionCallback.GetPageScale ( )

获取当前页面缩放值的回调函数。

此回调函数将由JavaScript属性"Doc.zoom"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

返回
缩放值。例如,缩放值 1.0 表示 100。它应该是一个正数。

◆ GetPageWindowRect()

def FoxitPDFSDKPython3.ActionCallback.GetPageWindowRect (   pdf_doc,
  page_index 
)

获取页面视图窗口矩形的回调函数。页面视图窗口是 内部文档窗口中显示PDF内容的区域。

参数
[in]page_index页面索引。

此回调函数将由JavaScript属性"Doc.pageWindowRect"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

返回
页面视图窗口的矩形。

◆ GetPageZoomMode()

def FoxitPDFSDKPython3.ActionCallback.GetPageZoomMode ( )

获取当前页面缩放模式的回调函数。

此回调函数将由JavaScript属性"Doc.zoom"或"Doc.zoomType"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

返回
缩放模式。请参考从 FoxitPDFSDKPython3.Destination.e_ZoomXYZ 开始的值, 它应该是这些值中的一个。

◆ GetPrinterNameList()

def FoxitPDFSDKPython3.ActionCallback.GetPrinterNameList ( )

获取打印机名称列表的回调函数。

此回调函数将由JavaScript属性"app.printerNames"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

返回
打印机名称数组。

◆ GetSignatureAPStyleNameList()

def FoxitPDFSDKPython3.ActionCallback.GetSignatureAPStyleNameList ( )

获取签名外观样式名称列表的回调函数。

此回调函数将由JavaScript方法"SecurityHandler.appearances"触发。 此回调函数是可选的,因此可以实现为不做任何事情。

返回
签名外观样式名称的数组。

◆ GetTemporaryDirectory()

def FoxitPDFSDKPython3.ActionCallback.GetTemporaryDirectory ( )

获取临时目录的回调函数。

此回调函数将由JavaScript方法"Doc.extractpages"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

返回
临时目录。

◆ GetTemporaryFileName()

def FoxitPDFSDKPython3.ActionCallback.GetTemporaryFileName (   document,
  file_suffix_name 
)

获取临时文件路径的回调函数。临时文件名将文档名与文件后缀名组合。

此回调函数将由JavaScript方法"Doc.mailForm"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]documentPDF文档对象。它应该是有效的。
[in]file_suffix_name文件后缀名。
返回
临时文件路径。

◆ GetUntitledBookmarkName()

def FoxitPDFSDKPython3.ActionCallback.GetUntitledBookmarkName ( )

获取无标题书签新名称的回调函数。

当JavaScript方法"bookmark.createChild"的参数"cName"为空字符串时, 将触发此回调函数。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

返回
无标题书签的新名称。

◆ GetVisiblePage()

def FoxitPDFSDKPython3.ActionCallback.GetVisiblePage (   document,
  index 
)

获取可见页的回调。

此回调函数是可选的,因此可以实现为不做任何事情。

参数
[in]documentPDF文档对象,它应该有效。
[in]index可见页索引。 有效范围: 从 0 到 (count-1)。 count 由接口 返回。
返回
可见页在PDF文档中的索引。

◆ GetVisiblePageCount()

def FoxitPDFSDKPython3.ActionCallback.GetVisiblePageCount (   document)

获取可见页页数的回调。

此回调函数是可选的,因此可以实现为不做任何事情。

参数
[in]documentPDF文档对象,它应该有效。
返回
可见页页数。

◆ InitModifyItem()

def FoxitPDFSDKPython3.ActionCallback.InitModifyItem (   document,
  item_type,
  page_index,
  dict_name 
)

初始化修改项的回调。

此回调函数是可选的,因此可以实现为不做任何事情。

参数
[in]documentPDF文档对象,它应该有效。
[in]item_type修改项类型。请参考值从 , 它的值应该是这些值中的一个。
[in]page_index被修改的页面索引。
[in]dict_name字典名称。
返回
无。

◆ InvalidateRect()

def FoxitPDFSDKPython3.ActionCallback.InvalidateRect (   document,
  page_index,
  pdf_rect 
)

使指定矩形内的客户区域无效的回调函数。

所有位置都以PDF"用户空间"测量。实现应调用函数 FoxitPDFSDKPython3.Renderer.StartRender 来重绘指定的页面区域。

参数
[in]documentPDF文档对象。它应该是有效的。
[in]page_index页面索引。它应该从0开始,小于指定文档的页数。
[in]pdf_rect指定中页面区域的矩形。 如果这是一个空矩形,表示刷新整个页面。
返回
true 表示成功,false 表示失败。

◆ IsCurrentDocOpenedInBrowser()

def FoxitPDFSDKPython3.ActionCallback.IsCurrentDocOpenedInBrowser ( )

获取标志的回调函数,该标志指定当前文档是否在浏览器中打开。

此回调函数将由JavaScript属性"doc.hostContainer"触发。 此回调函数是可选的,因此可以实现为不做任何事情。

返回
true 表示当前文档在浏览器中打开,false 表示未在浏览器中打开。

◆ IsLocalFile()

def FoxitPDFSDKPython3.ActionCallback.IsLocalFile (   document)

检查文件是否为本地文件的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]documentPDF文档对象。它应该是有效的。
返回
true 表示PDF文件是本地文件。

◆ IsPageLoop()

def FoxitPDFSDKPython3.ActionCallback.IsPageLoop ( )

获取标志的回调函数,该标志指定文档是否会循环回到文档开头以响应页面前进。

此回调函数将由JavaScript属性"app.fs.loop"触发。 此回调函数是可选的,因此可以实现为不做任何事情。

返回
true 表示循环回到文档开头,false 表示不循环。

◆ LaunchURL()

def FoxitPDFSDKPython3.ActionCallback.LaunchURL (   url)

启动到指定URL的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]url一个URL。
返回
true 表示成功,false 表示失败。

◆ MailData()

def FoxitPDFSDKPython3.ActionCallback.MailData (   data,
  data_type,
  is_ui,
  to,
  subject,
  cc,
  bcc,
  message 
)

发送数据或消息的回调函数,可以带有或不带有用户交互。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]data要发送的数据。 数据的值和类型取决于参数 data_type
[in]data_type邮件类型。请参考从 FoxitPDFSDKPython3.ActionCallback.e_MailTypeDoc 开始的值,它应该是这些值中的一个。
[in]is_uitrue 表示其余参数用于 填充显示给用户的新消息编写窗口。
false 表示参数 to 是必需的,其他所有参数 都是可选的。
[in]to指定消息收件人的分号分隔列表的字符串。
[in]subject指定消息主题的字符串。 此字符串长度限制为 64 KB。
[in]cc指定消息抄送收件人的分号分隔列表的字符串。
[in]bcc指定消息密送收件人的分号分隔列表的字符串。
[in]message指定消息内容的字符串。 此字符串长度限制为 64 KB。
返回
true 表示成功,false 表示失败。

◆ MailDoc()

def FoxitPDFSDKPython3.ActionCallback.MailDoc (   document,
  to_address,
  cc_address,
  bcc_address,
  subject,
  message,
  is_ui 
)

将文档作为附件发送邮件的回调函数。

此回调函数将由JavaScript方法"Doc.mailDoc"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]documentPDF文档对象。它应该是有效的。
[in]to_address收件人地址。
[in]cc_address抄送地址。
[in]bcc_address密送地址。
[in]subject邮件主题。
[in]message邮件消息。
[in]is_uitrue 表示显示邮件对话框,false 表示不显示。
返回
邮件结果。请参考从 FoxitPDFSDKPython3.ActionCallback.e_JSMailResultFailed 开始的值, 它应该是这些值中的一个。

◆ NotifyAfterDataChange()

def FoxitPDFSDKPython3.ActionCallback.NotifyAfterDataChange (   document,
  modify_item_info 
)

用于通知JS执行后内容已经被修改的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情。

参数
[in]documentPDF文档对象,它应该有效。
[in]modify_item_infoJavascriptModifyItemInfo 对象,它包含修改细节。
返回
None.

◆ NotifyBeginDoJob()

def FoxitPDFSDKPython3.ActionCallback.NotifyBeginDoJob (   document,
  event_type 
)

用于通知JS开始执行的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情。

参数
[in]documentPDF文档对象,它应该有效。
[in]event_typeJS事件类型。请参考值 FoxitPDFSDKPython3.JavascriptModifyItemInfo.e_JavascriptEventTypeUnknown , 它的值应该是这些值中的一个。
返回
None.

◆ NotifyEndDoJob()

def FoxitPDFSDKPython3.ActionCallback.NotifyEndDoJob (   document,
  event_type 
)

用于通知JS已经执行结束。

此回调函数是可选的,因此可以实现为不做任何事情。

参数
[in]documentPDF文档对象,它应该有效。
[in]event_typeJS事件类型。请参考值 FoxitPDFSDKPython3.JavascriptModifyItemInfo.e_JavascriptEventTypeUnknown , 它的值应该是这些值中的一个。
返回
None.

◆ OnFieldValueChanged()

def FoxitPDFSDKPython3.ActionCallback.OnFieldValueChanged (   field_name,
  type,
  value_before_changed,
  value_after_changed 
)

通知字段值变化的回调函数。

当字段的值通过JavaScript更改时,将触发此回调函数。

参数
[in]field_name指定字段名称的字符串。
[in]type字段值变化类型。请参考从 FoxitPDFSDKPython3.ActionCallback.e_JSFieldValueChangedByFormat 开始的值,它应该是这些值中的一个。
[in]value_before_changed指定字段变化前值的字符串数组。 对于列表框,该参数表示同时被选择的字段的一个或多个项目。
[in]value_after_changed指定字段变化后值的字符串数组。 对于列表框,该参数表示同时被选择的字段的一个或多个项目。
返回
无。

◆ OpenDoc()

def FoxitPDFSDKPython3.ActionCallback.OpenDoc (   file_path,
  password 
)

打开PDF文件的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]file_path现有PDF文件的完整路径。
[in]password输入PDF文件的密码。这可能是一个空字符串。
返回
已打开的PDF文档对象。

◆ OpenMediaPlayer()

def FoxitPDFSDKPython3.ActionCallback.OpenMediaPlayer (   player_args)

打开媒体播放器的回调函数。

此回调函数将由JavaScript方法"app.media.openPlayer"或"app.media.createPlayer"触发。

参数
[in]player_argsPlayerArgs 对象。
返回
一个 MediaPlayerCallback 对象。

◆ PopupMenu()

def FoxitPDFSDKPython3.ActionCallback.PopupMenu (   menus,
  is_selected_item 
)

弹出菜单窗口的回调函数。

菜单窗口的位置与光标的位置相同。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]menus菜单列表对象的数组。
[out]is_selected_item输出参数,接收菜单项是否被选择的值。 true 表示菜单项被选择,false 表示菜单项未被选择。
返回
被选择的菜单项的名称。

◆ PopupMenuEx()

def FoxitPDFSDKPython3.ActionCallback.PopupMenuEx (   menus,
  is_selected_item 
)

弹出菜单窗口的回调函数。

菜单窗口的位置与光标的位置相同。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]menusMenuItemEx 对象的数组。
[out]is_selected_item输出参数,接收菜单项是否被选择的值。 true 表示菜单项被选择,false 表示菜单项未被选择。
返回
被选择的菜单项的 MenuItemEx 对象。

◆ PostMessageToHtml()

def FoxitPDFSDKPython3.ActionCallback.PostMessageToHtml (   message)

向PDF文档的宿主容器的消息处理程序异步发送消息的回调函数。

要传递此消息,宿主容器(例如,HTML页面中的<OBJECT>元素)必须 通过设置其messageHandler属性来注册通知。
此回调函数将由JavaScript方法"doc.hostContainer.postMessage"触发。 此回调函数是可选的,因此可以实现为不做任何事情。

参数
[in]message指定要发布的消息的字符串数组。
返回
无。

◆ Print() [1/2]

def FoxitPDFSDKPython3.ActionCallback.Print (   document,
  is_ui,
  page_range,
  is_silent,
  is_shrunk_to_fit,
  is_printed_as_image,
  is_reversed,
  is_to_print_annots 
)

打印指定索引范围内页面的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]documentPDF文档对象。它应该是有效的。
[in]is_uitrue 表示应向用户显示UI 以获取打印信息并确认操作。
[in]page_range指定打印页面范围的范围对象。 此范围中表示的所有索引都从0开始, 小于指定文档的页面数。
[in]is_silenttrue 表示在文档打印时 应禁止显示取消对话框。
[in]is_shrunk_to_fittrue 表示页面应缩小(如果需要) 以适应打印页面的区域。
[in]is_printed_as_imagetrue 表示页面应作为图像打印。
[in]is_reversedtrue 表示打印顺序应从参数 end 到 参数 start
[in]is_to_print_annotstrue 表示注释应与页面一起打印。
返回
true 表示成功,false 表示失败。

◆ Print() [2/2]

def FoxitPDFSDKPython3.ActionCallback.Print (   document,
  print_params 
)

使用打印参数打印文档的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]documentPDF文档对象。它应该是有效的。
[in]print_params一个 PrintParams 对象。
返回
true 表示成功,false 表示失败。

◆ Query()

def FoxitPDFSDKPython3.ActionCallback.Query (   keywords,
  search_scope,
  search_option,
  di_path 
)

查询文本关键字的回调函数。

此回调函数将由JavaScript方法"search.query"触发。此回调函数是可选的, 因此可以实现为不做任何事情。

参数
[in]keywords要搜索的文本内容。
[in]search_scope指定文本应在何处搜索。请参考从 FoxitPDFSDKPython3.ActionCallback.e_SearchScopeActiveDoc 开始的值,它应该是这些值中的一个。
[in]search_option表示搜索选项的 SearchOption 对象。
[in]di_path用户计算机上文件夹或搜索索引的设备无关路径。此参数是 可选的。当 search_scopeFoxitPDFSDKPython3.ActionCallback.e_SearchScopeFolder FoxitPDFSDKPython3.ActionCallback.e_SearchScopeIndex 时,此参数是必需的。
返回
无。

◆ Release()

def FoxitPDFSDKPython3.ActionCallback.Release ( )

用于释放当前回调对象本身的回调函数。

返回
None.

◆ RemoveSearchIndex()

def FoxitPDFSDKPython3.ActionCallback.RemoveSearchIndex (   search_index_config)

(保留,尚不支持)移除搜索索引的回调函数。

此回调函数将由JavaScript方法"search.removeIndex"触发。此回调函数是可选的, 因此可以实现为不做任何事情。

参数
[in]search_index_config表示搜索索引配置的 SearchIndexConfig
返回
true 表示成功,false 表示失败。

◆ RemoveToolButtom()

def FoxitPDFSDKPython3.ActionCallback.RemoveToolButtom (   button_name)

移除通过函数 FoxitPDFSDKPython3.ActionCallback.AddToolButton 添加的工具按钮的回调函数。

此回调函数将由JavaScript方法"app.removeToolButton"触发。

参数
[in]button_name工具按钮的名称。
返回
true 表示成功,false 表示失败。

◆ ResetModifyItem()

def FoxitPDFSDKPython3.ActionCallback.ResetModifyItem (   document)

重置修改项的回调。

此回调函数是可选的,因此可以实现为不做任何事情。

参数
[in]documentPDF文档对象,它应该有效。
返回
无。

◆ Response()

def FoxitPDFSDKPython3.ActionCallback.Response (   question,
  title,
  default_value,
  label,
  is_password 
)

显示包含问题和输入字段供用户回复问题的对话框的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]question指定向用户提出的问题的字符串。
[in]title指定对话框标题的字符串。
[in]default_value指定作为问题答案的默认值的字符串。 如果未指定答案,则不显示默认值。
[in]label指定在编辑文本字段前面显示的短字符串。
[in]is_password布尔值,指示用户的响应是否应被掩码显示:
true 表示用户的响应应显示为星号 (*) 或项目符号 (?) 来掩码响应,这可能是敏感信息。
返回
用户的响应。可以是空字符串。

◆ Scroll()

def FoxitPDFSDKPython3.ActionCallback.Scroll (   point)

将当前页面上指定点滚动到当前视图中央的回调函数。

此回调函数将由JavaScript方法"Doc.scroll"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]point指定的点[PDF坐标系统]。
返回
无。

◆ SelectPageNthWord()

def FoxitPDFSDKPython3.ActionCallback.SelectPageNthWord (   page_index,
  start_offset,
  end_offset,
  is_show_selection 
)

更改当前页码并选择页面上指定单词的回调函数。

此回调函数将由JavaScript方法"Doc.selectPageNthWord"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]page_index页面索引。
[in]start_offset起始单词偏移量。
[in]end_offset结束单词偏移量。
[in]is_show_selectiontrue 表示显示选择,false 表示不显示。
返回
无。

◆ SetCurrentPage()

def FoxitPDFSDKPython3.ActionCallback.SetCurrentPage (   document,
  destination 
)

用于根据目标设置当前页面的回调函数。

此回调函数是可选的,可以实现为不执行任何操作。

参数
[in]documentPDF文档对象。该对象应当是有效的。
[in]destination

◆ SetDefaultPageTransitionMode()

def FoxitPDFSDKPython3.ActionCallback.SetDefaultPageTransitionMode (   trans_type,
  trans_di 
)

设置全屏模式下默认页面过渡模式的回调函数。

此回调函数将由JavaScript属性"app.fs.defaultTransition"触发。 此回调函数是可选的,因此可以实现为不做任何事情。

参数
[in]trans_type指定过渡效果类型的字符串。请参考以下值: "Split", "Box", "Fly", "Blinds", "Push", "Wipe", "Glitter", "Cover", "Uncover", "Dissolve", "Replace", "Fade"。
[in]trans_di指定过渡效果方向的字符串。
  • 对于 "Split",此值可以是 "HorizontalInward", "HorizontalOutward", "VerticalInward" 或 "VerticalOutward"。
  • 对于 "Box",此值可以是 "Outward" 或 "Inward"。
  • 对于 "Fly" 和 "Push",此值可以是 "Left", "Right", "Up" 或 "Down"。
  • 对于 "Blinds",此值可以是 "Horizontal" 或 "Vertical"。
  • 对于 "Wipe", "Glitter", "Uncover" 和 "Cover",此值可以是 "Left","LeftUp", "LeftDown", "Right", "RightUp", "RightDown","Up" 或 "Down"。
  • 对于 "Dissolve", "Replace" 和 "Fade",此值将为 NULL。

返回
无。

◆ SetDocChangeMark()

def FoxitPDFSDKPython3.ActionCallback.SetDocChangeMark (   document,
  change_mark 
)

设置更改标记的回调函数,该标记指示文档内容是否已更改。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]documentPDF文档对象。它应该是有效的。
[in]change_mark指示文档内容是否已更改的布尔值。
返回
true 表示成功,false 表示失败。

◆ SetFullScreen()

def FoxitPDFSDKPython3.ActionCallback.SetFullScreen (   is_full_screen)

设置全屏模式的回调函数。

当JavaScript属性"app.fullScreen"或"app.fs.isFullScreen"要被设置时,将触发此回调函数。

参数
[in]is_full_screentrue 表示设置全屏模式,false 表示不设置。
返回
无。

◆ SetIdentityProperties()

def FoxitPDFSDKPython3.ActionCallback.SetIdentityProperties (   identity_properties)

设置当前用户身份属性的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情。

参数
[in]identity_properties要设置的身份属性对象。
返回
true 表示成功,false 表示失败。

◆ SetLayoutMode()

def FoxitPDFSDKPython3.ActionCallback.SetLayoutMode (   layout_mode,
  is_cover_mode 
)

设置当前文档页面布局的回调函数。

此回调函数将由JavaScript属性"Doc.layout"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]layout_mode布局模式。请参考从 FoxitPDFSDKPython3.ActionCallback.e_LayoutModeSinglePage 开始的值, 它应该是这些值中的一个。
[in]is_cover_modetrue 表示封面将始终单独显示,false 表示不单独显示。
返回
无。

◆ SetPageRotation()

def FoxitPDFSDKPython3.ActionCallback.SetPageRotation (   document,
  page_index,
  rotation 
)

用于在PDF查看器中设置页面旋转值的回调函数。

此回调函数是可选的,可以实现为不执行任何操作。

参数
[in]documentPDF文档对象。该对象应当是有效的。
[in]page_index页面索引,用于指定要更改旋转的页面。 索引从0开始,应小于指定文档的页面总数。
[in]rotation新的旋转值。请参考从 FoxitPDFSDKPython3.e_Rotation0 开始的值, 应当是这些值中的一个,但不能是 FoxitPDFSDKPython3.e_RotationUnknown
返回
true 表示成功,false 表示失败。

◆ SetPageScale()

def FoxitPDFSDKPython3.ActionCallback.SetPageScale (   zoom_mode,
  dest 
)

设置当前页面缩放值的回调函数。

此回调函数将由JavaScript属性"Doc.zoom"或"Doc.zoomType"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]zoom_mode缩放模式。请参考从 FoxitPDFSDKPython3.Destination.e_ZoomXYZ 开始的值,它应该是这些值中的一个。
[in]dest表示目标数据的 FoxitPDFSDKPython3.Destination 对象。
返回
无。

◆ ShowDialog()

def FoxitPDFSDKPython3.ActionCallback.ShowDialog (   dlg_config)

显示对话框的回调函数。

此回调函数将由JavaScript方法"app.execDialog"触发。

参数
[in]dlg_configDialogDescriptionConfig 对象。
返回
true 表示成功,false 表示失败。

◆ SoapRequest()

def FoxitPDFSDKPython3.ActionCallback.SoapRequest (   request_params)

启动远程过程调用 (RPC) 或向 SOAP HTTP 端点发送 XML 消息。

该方法要么等待端点回复(同步处理),要么调用 通知对象上的方法(异步处理)。
此回调函数将由JavaScript方法"SOAP.request"触发。 此回调函数是可选的,因此可以实现为不做任何事情。

参数
[in]request_params包含 SOAP 请求属性参数的 SOAPRequestProperties 对象。
返回
一个 SOAPResponseInfo 对象。

◆ SubmitForm()

def FoxitPDFSDKPython3.ActionCallback.SubmitForm (   document,
  form_data,
  length,
  url,
  file_format_type 
)

向指定URL提交表单数据的回调函数。

此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

参数
[in]documentPDF文档对象。它应该是有效的。
[in]form_data要提交的表单数据缓冲区。
[in]length缓冲区参数 form_data 的大小(以字节为单位)。
[in]url表单数据将被提交到的URL。
[in]file_format_type提交表单的文件格式类型。请参考从 FoxitPDFSDKPython3.e_FileFormatTypeFDF 开始的值, 它应该是这些值中的一个。
返回
true 表示成功,false 表示失败。

◆ UpdateLogicalLabel()

def FoxitPDFSDKPython3.ActionCallback.UpdateLogicalLabel ( )

更新逻辑标签的回调函数。

此回调函数将由JavaScript方法"Doc.setPageLabels"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。

返回
无。

◆ VerifySignature()

def FoxitPDFSDKPython3.ActionCallback.VerifySignature (   document,
  pdf_signature 
)

验证指定签名的回调函数。

当动作需要验证签名时,将触发此回调函数。 如果用户不想验证签名,只需实现此函数不做任何事情, 只返回 FoxitPDFSDKPython3.Signature.e_StateUnknown 。 建议用户使用类 FoxitPDFSDKPython3.LTVVerifier 来验证已签名的签名是否有效。

参数
[in]documentPDF文档对象。它应该是有效的。
[in]pdf_signature已签名的PDF签名。此签名属于输入参数 document
返回
签名验证状态。请参考从 FoxitPDFSDKPython3.Signature.e_StateUnknown 开始的值, 它应该是其中的一个或多个的组合。